#2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] #3017

zandercymatics · 2024-11-01T17:44:34Z

Ticket

Resolves #2927

Changes

Changes the DomainRequestWizard such that the domain request flow now takes an id in the url path, rather than in the session
Fixes existing tests on the domain request page to pass in an id
Adds a breadcrumb to the first page of the domain request flow (such that you can go back to the home page), and kept the old back button on the rest

Context for reviewers

Context for design:
The only design change is a breadcrumb on the first page of the domain request flow. This exists on the non-org view as well.

General context:
This bug was happening because the original DomainRequestWizard was actually storing the domain request id and the "new_request" variable in the session. Because our session is in our database as a CacheTable, this meant that you could override the session state by taking other actions in another tab.

The fix for this is to simply expose the domain request id in the actual url itself, rather than relying on session to store this information for us.

Because we are now removing the id, this does reintroduce the back button bug. It was decided that this would be resolved with a new design, so a breadcrumb has also been added to the first step of the domain request flow.

Setup

(devs only) You can reproduce the original bug on another sandbox by doing the following:

Open the app in two tabs (or two browsers)
On one of the tabs, start a new domain request and complete some of it. Stop midway through.
On the other tab, click start a new domain request again. Either one of two things will happen, depending on the order in which you complete these steps: the request will look like its already filled out, or the request on your original tab will lose its progress (you will need to click on another step to trigger another get or post)

For this ticket, follow these same steps on getgov-meoward. This behavior should now no longer exist.

To test the new breadcrumb (both portfolio and non portfolio:

Start a new domain request, and note the breadcrumb on the first step
Go to the second step. Note the old context.

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

Met the acceptance criteria, or will meet them in a subsequent PR
Created/modified automated tests
Update documentation in READMEs and/or onboarding guide

Ensured code standards are met (Original Developer)

If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
Interactions with external systems are wrapped in try/except
Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

Tag @dotgov-designers in this PR's Reviewers for design review. If code is not user-facing, delete design reviewer checklist
Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
Checked keyboard navigability
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

Pulled this branch locally and tested it
Verified code meets all checks above. Address any checks that are not satisfied
Reviewed this code and left comments. Indicate if comments must be addressed before code is merged
Checked that all code is adequately covered by tests
Verify migrations are valid and do not conflict with existing migrations - NA

Validated user-facing changes as a developer

Note: Multiple code reviewers can share the checklists above, a second reviewer should not make a duplicate checklist. All checks should be checked before approving, even those labeled N/A.

New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
Checked keyboard navigability
Meets all designs and user flows provided by design/product
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
(Rarely needed) Tested as both an analyst and applicant user - NA

As a designer reviewer, I have

Verified that the changes match the design intention

Checked that the design translated visually
Checked behavior. Comment any found issues or broken flows.
Checked different states (empty, one, some, error)
Checked for landmarks, page heading structure, and links

Validated user-facing changes as a designer

Checked keyboard navigability
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
Tested with multiple browsers (check off which ones were used)
- Chrome
- Microsoft Edge
- FireFox
- Safari
(Rarely needed) Tested as both an analyst and applicant user

References

Code review best practices

Screenshots

Doesn't account for clicking the button after page refresh

This reverts commit f4c6c08.

github-actions · 2024-11-01T17:49:12Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-01T18:15:57Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-01T19:41:37Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-01T19:57:50Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-01T21:09:27Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-04T15:56:04Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-04T18:34:14Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-04T20:30:07Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-04T21:02:36Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-04T21:08:52Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-06T15:33:33Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-06T15:46:04Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-07T17:46:46Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-07T18:50:47Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-07T19:47:30Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-07T19:50:46Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-11-07T20:04:04Z

🥳 Successfully deployed to developer sandbox za.

erinysong · 2024-11-07T22:54:44Z

Tested the following:

Created a new domain request, filled form up to senior official and exited back to home page.
Click on create a domain request button and was directed to a blank new form with a new session id

3. When I go back to my original incompleted domain request in step 1, I am redirected back to the first domain request with its progress maintained where I last left the domain request form

erinysong

Verified and tested ACs + code LGTM! Just had two small questions and can approve afterwards

erinysong · 2024-11-07T22:57:19Z

src/registrar/config/urls.py

 domain_request_urls = [
-    path("", views.DomainRequestWizard.as_view(), name=""),
+    path("", RedirectView.as_view(pattern_name="domain-request:start"), name="redirect-to-start"),
+    path("start/", views.DomainRequestWizard.as_view(), name="start"),


erinysong · 2024-11-07T23:09:07Z

src/registrar/views/domain_request.py

@@ -182,7 +183,9 @@ def configure_step_options(self):

    def has_pk(self):
        """Does this wizard know about a DomainRequest database record?"""
-        return "domain_request_id" in self.storage
+        if self.kwargs.get("id") is not None:


does this work the same if we one liner this to return self.kwargs.get("id") or return self.kwargs.get("id") is not None?

Great suggestion! The is not None one liner should return the same thing

erinysong · 2024-11-07T23:11:37Z

src/registrar/views/domain_request.py

@@ -493,6 +493,7 @@ def get_context_data(self):
        # Hides the requests and domains buttons in the navbar
        context_stuff["hide_requests"] = self.is_portfolio
        context_stuff["hide_domains"] = self.is_portfolio
+        context_stuff["domain_request_id"] = self.domain_request.id


I know this is for pre-existing code not in scope, but thoughts on renaming this variable to form_context or something along the lines of that?

What do you think about context? I'm not opposed to doing that, I was thinking the same thing

I think just context also works! Glad we were in agreement 🎉

github-actions · 2024-11-08T17:02:33Z

🥳 Successfully deployed to developer sandbox za.

erinysong

LGTM! 🚢

Katherine-Osos

LGTM!

zandercymatics added 5 commits October 31, 2024 13:54

kind of a solution

f4c6c08

Doesn't account for clicking the button after page refresh

Revert "kind of a solution"

e19923f

This reverts commit f4c6c08.

use id instead of session for domain requests

aa930eb

fix session issue

37894e7

Update domain_request.py

20a5774

zandercymatics requested a review from abroddrick as a code owner November 1, 2024 17:44

Merge branch 'main' into za/2927-blocked-from-starting-requests

42bf6ef

zandercymatics changed the title ~~[DRAFT] #2927: Bug - blocked from starting requests~~ [DRAFT] #2927: Bug - blocked from starting requests - [MEOWARD] Nov 1, 2024

cleanup urls a bit

18e25b0

Merge branch 'main' into za/2927-blocked-from-starting-requests

d216953

(draft) get a domain id per session

4ae764b

Cleanup

8660e6b

Lint and fix up some tests

618890d

Fix (some) unit tests

d2ebf89

url

5feddde

Update test_views_request.py

5acec7c

Update test_views_request.py

927eb96

Update test_views_request.py

6532db8

Add back button

e0a7352

Add breadcrumb

e1006ed

zandercymatics added 2 commits November 7, 2024 12:41

Unit test

5fa622a

Update test_views_request.py

14f861b

zandercymatics requested review from Matt-Spence, CocoByte, rachidatecs, dave-kennedy-ecs, Katherine-Osos, erinysong, asaki222 and a team November 7, 2024 19:47

Update test_views_request.py

f5cc5a6

zandercymatics changed the title ~~[DRAFT] #2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD]~~ #2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] Nov 7, 2024

erinysong self-assigned this Nov 7, 2024

erinysong reviewed Nov 7, 2024

View reviewed changes

PR suggestions

dd574bc

erinysong approved these changes Nov 8, 2024

View reviewed changes

Katherine-Osos removed the request for review from a team November 13, 2024 22:54

Katherine-Osos approved these changes Nov 13, 2024

View reviewed changes

Merge branch 'main' into za/2927-blocked-from-starting-requests

cea4ba5

zandercymatics merged commit 764ad7a into main Nov 14, 2024
8 of 10 checks passed

zandercymatics deleted the za/2927-blocked-from-starting-requests branch November 14, 2024 15:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] #3017

#2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] #3017

zandercymatics commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

erinysong commented Nov 7, 2024 •

edited

Loading

erinysong left a comment

erinysong Nov 7, 2024

erinysong Nov 7, 2024

zandercymatics Nov 8, 2024

erinysong Nov 7, 2024

zandercymatics Nov 8, 2024

erinysong Nov 8, 2024

github-actions bot commented Nov 8, 2024

erinysong left a comment

Katherine-Osos left a comment

#2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] #3017

#2927: Blocked from starting a new domain request when there are other started domain requests - [MEOWARD] #3017

Conversation

zandercymatics commented Nov 1, 2024 • edited Loading

Ticket

Changes

Context for reviewers

Setup

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

Ensured code standards are met (Original Developer)

Validated user-facing changes (if applicable)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

Validated user-facing changes as a developer

As a designer reviewer, I have

Verified that the changes match the design intention

Validated user-facing changes as a designer

References

Screenshots

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 6, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

erinysong commented Nov 7, 2024 • edited Loading

erinysong left a comment

Choose a reason for hiding this comment

erinysong Nov 7, 2024

Choose a reason for hiding this comment

erinysong Nov 7, 2024

Choose a reason for hiding this comment

zandercymatics Nov 8, 2024

Choose a reason for hiding this comment

erinysong Nov 7, 2024

Choose a reason for hiding this comment

zandercymatics Nov 8, 2024

Choose a reason for hiding this comment

erinysong Nov 8, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 8, 2024

erinysong left a comment

Choose a reason for hiding this comment

Katherine-Osos left a comment

Choose a reason for hiding this comment

zandercymatics commented Nov 1, 2024 •

edited

Loading

erinysong commented Nov 7, 2024 •

edited

Loading